GermanWikipedia - /page/entry.mu

Micron Document

<!DOCTYPE html>

<title>Annotation (Java)</title>

</head>

<h1 id="firstHeading" class="firstHeading mw-first-heading">Annotation (Java)</h1>

</header>

</div>

<div id="mw-content-text" class="mw-body-content mw-content-ltr" lang="de" dir="ltr"><div class="mw-content-ltr mw-parser-output" lang="de" dir="ltr">Als Annotation wird im Zusammenhang mit der <a href="Programmiersprache" title="Programmiersprache">Programmiersprache</a> <a href="Java_(Programmiersprache)" title="Java (Programmiersprache)">Java</a> ein Sprachelement bezeichnet, das die Einbindung von <a href="Metadaten#Metadaten_in_der_Softwareentwicklung" title="Metadaten">Metadaten</a> in den <a href="Quelltext" title="Quelltext">Quelltext</a> erlaubt. Dieses Element wurde im <a href="Java_Specification_Request" title="Java Specification Request">JSR</a> 175 festgelegt und mit der Version Java 5.0 eingeführt.

Annotationen beginnen mit einem @-Zeichen. Daran schließt sich ihr Name an. Optional kann eine kommagetrennte Parameterliste folgen, die in runden Klammern eingefasst wird. Beispielsweise markiert die Annotation im folgenden Quelltextausschnitt die Klasse A als überholt (<a href="Deprecated" class="mw-redirect" title="Deprecated">deprecated</a>):

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Deprecated

public class A {}

</pre></div>

Ein Annotation Processor ist ein Compiler-Plugin, das Annotationen beim Kompilieren auswerten kann, um damit Warnungen und Fehlermeldungen zu unterdrücken oder auszulösen oder weiteren Quellcode oder andere Dateien zu generieren. Mit Annotationen versehenen Code kann er jedoch nicht ändern. Annotationen, bei denen das vorgesehen ist, können auch zur Laufzeit mittels <a href="Reflexion_(Programmierung)" title="Reflexion (Programmierung)">Reflection</a> ausgewertet werden.

Eingesetzt werden Annotationen unter anderem im <a href="Jakarta_EE" title="Jakarta EE">Jakarta-EE</a>-Umfeld, um Klassen um Informationen zu erweitern, die vor Java 5 in separaten Dateien hinterlegt werden mussten. Prominente Beispiele sind Home- und Local-Interfaces sowie Deployment-Deskriptoren.

Eine Vorgängertechnik zur Einbettung von Metadaten in Java-Quelltexten ist die Verwendung spezieller <a href="Javadoc" title="Javadoc">Javadoc</a>-Kommentare. Diese wurden mit Hilfe sogenannter <a href="Doclet" title="Doclet">Doclets</a> ausgewertet. Ein vielfach eingesetztes Werkzeug für diese Methode ist <a href="XDoclet" title="XDoclet">XDoclet</a>. Diese Technik kann auch nach Einführung der Annotationen weiterhin verwendet werden.

<div class="mw-heading mw-heading2"><h2 id="Vordefinierte_Annotationstypen">Vordefinierte Annotationstypen</h2></div>

In <a href="Java_Platform_Standard_Edition" class="mw-redirect" title="Java Platform Standard Edition">Java SE 5.0</a> stehen sieben vordefinierte Annotationstypen zur Verfügung, die in den Paketen (<a href="Java-Syntax#Pakete,_Namen,_Klassen,_Schnittstellen" title="Java-Syntax">Package</a>) <code>java.lang</code> oder <code>java.lang.annotation</code> liegen. Sie werden alle (im Gegensatz zu den meisten Annotationen) vom Compiler ausgewertet. Weitere können von Programmierern erstellt werden.

<th>Annotation

</th>

<th>Beschreibung

</th></tr>

<tr>

<td colspan="2" align="left">Im Paket <code>java.lang</code> befinden sich Annotationen.

</td></tr>

<tr>

<td>@Deprecated

</td>

<td>Hiermit können Klassen, Attribute oder Methoden gekennzeichnet werden, die nicht mehr verwendet werden sollen. Der Compiler gibt dann eine Warnung aus, wenn ein so gekennzeichnetes Element verwendet wird.

Es empfiehlt sich zusätzlich, einen <a href="Javadoc" title="Javadoc">Javadoc</a>-Kommentar anzubringen, der aufzeigt, wie das entsprechende Element ersetzt werden soll. Das folgende Beispiel zeigt dies:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>/**

* @deprecated Die Klasse A wurde mit Version 10.3 durch die Klasse ANeu ersetzt.

*/

@Deprecated

public class A {}

</pre></div>

</td></tr>

<tr>

<td>@Override

</td>

<td>Mit diesem Typ kann eine Methode gekennzeichnet werden, die die Methode ihrer Oberklasse überschreibt. Der Compiler stellt dann sicher, dass die Oberklasse diese Methode enthält und gibt einen Fehler aus, wenn dies nicht der Fall ist.

Beispiel:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>public class A {

public void eineMethode() {}

}

public class B extends A {

@Override

}

</pre></div>

</td></tr>

<tr>

<td>@SuppressWarnings

</td>

<td>Bei der Verwendung dieses Annotationstyps unterdrückt der Compiler bestimmte Warnungen. Der Annotation wird dazu ein Array mit Strings übergeben, die die zu unterdrückenden Warnungen enthalten.

Im folgenden Beispiel wird der Compiler angewiesen, die deprecated-Warnung für die Klasse EineDeprecatedKlasse zu unterdrücken:

@SuppressWarnings({"deprecation"})

EineDeprecatedKlasse b = new EineDeprecatedKlasse();

}

}

</pre></div>

</td></tr>

<tr>

<td>@SafeVarargs

</td>

<td>Mit dieser Annotation wird versichert, dass die Varargs-Parameter mit Generics nicht zur Laufzeit mit einem unpassenden Generics-Typ ersetzt werden. Beim Aufruf der Methode bzw. des Konstruktors wird dann keine Warnung angezeigt. Die Annotation wurde mit Java 7 eingeführt. Bis Java 6 konnte man beim Aufruf mit einer @SuppressWarnings-Annotation das Vertrauen in den aufgerufenen Code dokumentieren, ab Java 7 kann die Methode sich selbst als vertrauenswürdig deklarieren.

</td></tr>

<tr>

<td colspan="2" align="left">Im Paket <code>java.lang.annotation</code> – diese werden nur für die Definition von Annotationen gebraucht.

</td></tr>

<tr>

<td>@Documented

</td>

<td>Dieser Annotationstyp wird als Meta-Annotation verwendet: Eine Annotation dieses Typs legt für einen neu erstellten Annotationstyp fest, dass er von Javadoc bei der Erzeugung der Dokumentation berücksichtigt wird.

</td></tr>

<tr>

<td>@Inherited

</td>

<td>Dieser Annotationstyp wird bei der Programmierung einer Annotation angewandt. Damit kann festgelegt werden, dass diese zusammen mit einer Klasse vererbt wird. Wird diese Annotation dann beispielsweise bei einer bestimmten Klasse angewendet, so gilt diese auch für alle Klassen, die von dieser erben.

</td></tr>

<tr>

<td>@Retention

</td>

<td>Dieser Typ wird bei der Programmierung einer Annotation angewandt. Sie gibt an, wann auf sie selbst zugegriffen werden kann. Es gibt drei mögliche Werte für eine Annotation dieses Typs, die in der <a href="Aufz%C3%A4hlungstyp" title="Aufzählungstyp">Enumeration</a> <code>java.lang.annotation.RetentionPolicy</code> aufgeführt sind:

<dl><dt>CLASS</dt>

<dd>Die Annotation wird mit der Klasse kompiliert und ist damit in der .class-Datei vorhanden. Allerdings kann sie nicht während der Laufzeit einer Anwendung ausgelesen werden. Dies ist der Standardwert.</dd>

<dt>RUNTIME</dt>

<dd>Die Annotation kann während der Laufzeit einer Anwendung mittels des <a href="Reflexion_(Programmierung)" title="Reflexion (Programmierung)">Reflection-Mechanismus</a> ausgelesen werden.</dd>

<dt>SOURCE</dt>

<dd>Die Annotation wird vor dem Kompilieren aus dem Quelltext entfernt. Entsprechend steht sie zur Laufzeit eines Programms nicht zur Verfügung.</dd></dl>

</td></tr>

<tr>

<td>@Target

</td>

<td>Dieser Annotationstyp wird bei der Programmierung einer Annotation angewandt. Damit wird festgelegt, auf welche Elemente eines Programms sie angewendet werden darf. Die möglichen Werte für eine Annotation dieses Typs sind in der Enumeration <code>java.lang.annotation.ElementType</code> aufgeführt.

<dd>Die Annotation kann nur auf Klassen, Interfaces oder Enumerations angewandt werden.</dd>

<dt>FIELD</dt>

<dd>Die Annotation kann nur auf Felder angewandt werden.</dd>

<dt>METHOD</dt>

<dd>Die Annotation kann nur auf Methoden angewandt werden. Konstruktoren sind dabei ausgeschlossen.</dd>

<dt>PARAMETER</dt>

<dd>Die Annotation kann nur auf Parameter von Methoden und Konstruktoren angewandt werden.</dd>

<dt>CONSTRUCTOR</dt>

<dd>Die Annotation kann nur auf Konstruktoren angewandt werden.</dd>

<dt>LOCAL_VARIABLE</dt>

<dd>Die Annotation kann nur auf lokale Variablen angewandt werden.</dd>

<dt>ANNOTATION_TYPE</dt>

<dd>Die Annotation kann nur auf Annotationen angewandt werden.</dd>

<dt>PACKAGE</dt>

<dd>Die Annotation kann nur auf Paketen angewandt werden.</dd></dl>

</td></tr></tbody></table>

<div class="mw-heading mw-heading2"><h2 id="Definition_eigener_Annotationen">Definition eigener Annotationen</h2></div>

Annotationen sind spezielle Schnittstellen; ihre Namen werden daher konventionsgemäß mit großem Anfangsbuchstaben geschrieben. In ihrer Vereinbarung steht vor <code>interface</code> das Zeichen <code>@</code>. Sie erweitern implizit die Schnittstelle <code>java.lang.annotation.Annotation</code>. Sie dürfen keine andere Schnittstellen erweitern (d. h. <code>extends</code> ist verboten) und sind nicht generisch. Ihre Methoden sind parameterlos und nicht-generisch. Als Ergebnistypen (return type) sind nur folgende Typen erlaubt:

<ul><li>primitive Typen</li>

<li>Aufzählungstypen (<code>enum</code>)</li>

<li>Annotationstypen</li>

<li><code>String</code></li>

<li><code>Class</code></li>

<li>Felder (arrays) aus diesen Typen</li></ul>

Sie werfen auch keine Ausnahmen und dürfen keine Rekursion verwenden.

Viele Annotationen enthalten keine Methoden. Ein Beispiel wäre:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@interface Vorlaeufig { }

</pre></div>

Andere Annotationen enthalten (wie für Schnittstellen üblich) Methoden, allerdings nur mit den oben aufgeführten Ergebnistypen. Wenn eine Annotation nur eine Methode enthält, ist ihr Name konventionsgemäß <code>value</code>:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@interface Test {

boolean value(); // true solange nicht freigegeben

}

</pre></div>

oder

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@interface Autoren {

String[] value(); // Namen der Autoren

}

</pre></div>

oder

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@interface Kunden {

Person[] value();

}

</pre></div>

wobei Person als Aufzählungstyp (<code>enum</code>) oder Annotation definiert werden muss, z. B.:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@interface Person {

String name();

int alter();

}

</pre></div>

Bei der Vereinbarung von Annotationen werden häufig die Standard-Annotationen aus dem Paket <code>java.lang.annotation</code> verwendet. Insbesondere soll mit <code>@Retention</code> angegeben werden, wie lange die Annotation aufbewahrt werden soll: nur im Quelltext (<code>SOURCE</code>), in der gespeicherten class-Datei (<code>CLASS</code>) oder auch in der geladenen Klasse (<code>RUNTIME</code>). <code>@Target</code> beschreibt, für welche Programmelemente die Annotation verwendet werden darf. Beispielsweise sind alle Annotationsvereinbarungen im Paket <code>java.lang.annotation</code> mit den Annotationen

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Documented

@Retention(value=RUNTIME)

@Target(value=ANNOTATION_TYPE)

</pre></div>

versehen. Hierdurch werden sie alle von javadoc ausgewertet, im <a href="Bytecode" title="Bytecode">Bytecode</a> mit geladen und können so zur Laufzeit ausgewertet werden; außerdem dürfen sie nur für Annotationstypen verwendet werden.

<div class="mw-heading mw-heading2"><h2 id="Verwendung_eigener_Annotationen">Verwendung eigener Annotationen</h2></div>

Eine Annotation ohne Methoden, wie <code>@Vorlaeufig</code>, kann z. B. einer Klasse vorangestellt werden:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Vorlaeufig

class Klasse {

void methode();

}

</pre></div>

Einer Annotation mit nur einer Methode mit dem Namen <code>value</code> muss in Klammern ein konstanter Wert vom Ergebnistyp dieser Methode mit angegeben werden:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Test(true)

public void methode() { ... }

</pre></div>

Wenn der Ergebnistyp ein Array ist, soll ein Arrayliteral verwendet werden:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Autoren({"Solymosi", "Grude"})

String buch = "Algorithmen und Datenstrukturen mit Java"

</pre></div>

Wenn das Array keine Elemente enthält, muss <code>({})</code> mit angegeben werden. Wenn das Array jedoch nur ein Element enthält, können die geschweiften Klammern weggelassen werden:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Autoren("Solymosi")

String anderesBuch = "Programmieren in Scala"

</pre></div>

Einer Annotation mit mehreren Methoden muss jeder ihrer Methoden in Klammern ein konstanter Wert zugewiesen werden:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Person(name = "Andreas Solymosi", alter = 56)

Konto konto = new Konto();

</pre></div>

Die Möglichkeit, den Wert mit dem Namen anzugeben, besteht auch für Annotationen mit einer Methode (ist allerdings überflüssig, dient höchstens der Lesbarkeit):

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Test(value = true)

</pre></div>

Eine komplexe (geschachtelte) Annotation muss geschachtelt angewendet werden:

<div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>@Kunden(@Person(name = "Andreas Solymosi", alter = 56))

class Unternehmen { … }

</pre></div>

In der Vereinbarung der Annotation können für die Methoden Standardwerte definiert werden; dann kann der entsprechende Wert bei der Verwendung weggelassen werden. Da Annotationen Schnittstellen sind, können sie selber mit Annotationen markiert werden:

public @interface Test {

boolean wert() default false; // muss nicht unbedingt wert heißen

}

</pre></div>

<div class="mw-heading mw-heading2"><h2 id="Auswertung_von_Annotationen">Auswertung von Annotationen</h2></div>

Wenn die Annotationen mit dem Bytecode der Klasse geladen werden, können sie mit Hilfe von Reflexion ausgewertet werden. Beispielsweise kann man feststellen, ob eine Annotation angegeben wurde oder nicht:

<code>

boolean istVorlaeufig = Klasse.class.isAnnotationPresent(Vorlaeufig.class);

</code>

Wenn man festgestellt hat, dass die Annotation vorhanden ist, dann kann man auch ihren Wert lesen, z. B. ob die Methode noch im Testzustand ist oder nicht:

<code>

Test test = Klasse.class.getMethod("methode", new Class[]{}).getAnnotation(Test.class).value();

</code>

Wenn hierbei die Annotation nicht vorhanden ist, wird von <code>getAnnotation()</code> die Ausnahme <code>NullPointerException</code> ausgelöst.

Aus einer komplexen Annotation müssen ihre Elemente einzeln selektiert werden:

<code>

Person kunden = Unternehmen.class.getAnnotation(Kunden.class).value()[0];

</code>

<div class="mw-heading mw-heading2"><h2 id="Annotation_von_Paketen">Annotation von Paketen</h2></div>

Die Java Language Specification erlaubt auch die Annotation von Paketen, beispielsweise um Dokumentation zu einem Paket bereitzustellen. Pro Paket darf maximal eine <code>package</code>-Deklaration mit Annotationen versehen sein. Falls ein Paket Annotationen erhalten soll, empfiehlt die Java Language Specification, eine gesonderte Datei namens <code>package-info.java</code> im Verzeichnis dieses Pakets anzulegen. Diese Datei beinhaltet dann die <code>package</code>-Deklaration mit den Annotationen.

<div class="mw-heading mw-heading2"><h2 id="Weblinks">Weblinks</h2></div>

<ul><li><a rel="nofollow" class="external text" href="http://public.beuth-hochschule.de/~solymosi/veroeff/Annotationen.html">Annotationen in Java</a></li>

<li><a rel="nofollow" class="external text" href="http://docs.oracle.com/javase/tutorial/java/annotations/">Annotations</a> in Suns Java-Tutorial (englisch)</li>

<li><a rel="nofollow" class="external text" href="http://docs.oracle.com/javase/1.5.0/docs/guide/apt/index.html">Annotation Processing Tool (apt)</a> (englisch)</li>

<li><a rel="nofollow" class="external text" href="http://docs.oracle.com/javase/1.5.0/docs/guide/language/annotations.html">The J2SE 5.0 Annotations Feature</a> bei Sun (englisch)</li>

<li><a rel="nofollow" class="external text" href="http://jcp.org/en/jsr/detail?id=175">JSR 175: A Metadata Facility for the JavaTM Programming Language</a> (englisch)</li>

<li><a rel="nofollow" class="external text" href="http://docs.oracle.com/javase/specs/jls/se8/html/jls-9.html#jls-9.7">Annotations</a> in der <a href="Java_Language_Specification" title="Java Language Specification">Java Language Specification</a> (englisch)</li>

<li><a rel="nofollow" class="external text" href="https://openbook.rheinwerk-verlag.de/javainsel/10_008.html#u10.8">Annotationen</a> in „Java ist auch eine Insel“</li></ul></div><div><div class="zim-footer">

Dieser Artikel wurde von <a class="external text" title="Zuletzt bearbeitet am 2024-12-18" href="https://de.wikipedia.org/wiki/?title=Annotation_(Java)&oldid=251359633">Wikipedia</a> herausgegeben. Der Text ist unter <a class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/deed.de">Creative Commons Attribution-Share Alike 4.0</a> verfügbar, sofern nicht anders angegeben. Für die Mediendateien können zusätzliche Bedingungen gelten.

</div>

</div></div>

</div>

</main>

</div>

</body></html>